CIMPLICITY REST API Web Service
CIMPLICITY REST API Web Service / All Operations Resource Group / /projects/{projectId}/SQLConnections (Post)
Post/projects/{projectId}/SQLConnections
Description
Creates or updates an array of sql connections in the project
Parameters
NameDescriptionData Type
the id of the projectstring
Request (application/json)

The request body is of type object.

Overview

SQLDefaultConnections : Array[CimSQLConnection]
ConnectionType : CimSQLConnectionType
ODBCDataSource : string
ODBC Data connection.
UserID : string
User who will connect to the selected database driver. A database user name is required if you are connecting to a SQL Server.
Passsword : string
Password needed to connect to the selected database driver. A password is required if you are connecting to a SQL Server.
ReconnectWaitPeriod : integer
The amount of time that the Database Logger waits between reconnect attempts when the connection to the database is lost.
ReconnectWaitUnit : CimTimeUnitEnum
defines units for time values
EnableStoreAndForward : boolean
Choose enable store and forward to enable the ALARM_LOG table perform store and forward options.
MaxNumberOfStoredRecord : number
To select the number of records the Database Logger will store when its connection to the database is down. Enter a number between 1 and 4294967285. 0 indicates no limit.
SQLTableConnections : Array[CimSQLTableConnection]
Table_id : string
Table id on which connection is updated.
SQLConnection : CimSQLConnection
Fields that describe the connection to a SQL connection
ConnectionType : CimSQLConnectionType
ODBCDataSource : string
ODBC Data connection.
UserID : string
User who will connect to the selected database driver. A database user name is required if you are connecting to a SQL Server.
Passsword : string
Password needed to connect to the selected database driver. A password is required if you are connecting to a SQL Server.
ReconnectWaitPeriod : integer
The amount of time that the Database Logger waits between reconnect attempts when the connection to the database is lost.
ReconnectWaitUnit : CimTimeUnitEnum
defines units for time values
EnableStoreAndForward : boolean
Choose enable store and forward to enable the ALARM_LOG table perform store and forward options.
MaxNumberOfStoredRecord : number
To select the number of records the Database Logger will store when its connection to the database is down. Enter a number between 1 and 4294967285. 0 indicates no limit.
Dynamic : boolean
200 Response

The response body is of type ItemsPostResponse.

The SQL connection configuration is successful.

Overview

ItemsPostResponse
The results of the create/update/delete operations.
NumSuccesses : number
The number of items that were successfully written.
NumFailures : number
The number of items that failed to be written.
WarningsMask : integer
a bitmask of warning conditions (e.g., WarningLicensePointCount)
ItemResults : Array[ItemResult]
The results for each item in the request array.
Success : boolean
high level result (success true, failure false)
StatusDetails : integer
a value giving more details about the status (e.g., SuccessNew, SuccessModified, FailureDupInRequest, FailureDupInObject, and then a bunch of FailureXyzzy, ...)
WarningsMask : integer
a bitmask of warning conditions (e.g., IE_SNF_NO_GLB_TRIG_MSG)
Message : string
(localized?) message about the result, probably empty for successes
Fault Responses
FaultDescription
This fault returns a response body of type ProblemDetails.
Error if objects not found
This fault returns a response body of type ProblemDetails.
General error
See Also